Skip to content

ww3_doxy_tmpl.md: fix module vars#599

Merged
aliabdolali merged 2 commits into
NOAA-EMC:developfrom
MatthewMasarik-NOAA:doc/module-vars
Feb 1, 2022
Merged

ww3_doxy_tmpl.md: fix module vars#599
aliabdolali merged 2 commits into
NOAA-EMC:developfrom
MatthewMasarik-NOAA:doc/module-vars

Conversation

@MatthewMasarik-NOAA
Copy link
Copy Markdown
Contributor

@MatthewMasarik-NOAA MatthewMasarik-NOAA commented Jan 26, 2022 •
edited
Loading

Pull Request Summary

Fixes the module header in ww3_doxy_tmpl.md regarding variables.

Description

Provide a detailed description of what this PR does.

  • The header for MODULEs displayed documentation of variables incorrectly. They were shown using the @param tag, which should not be used, and instead documentation should be done inline. That is directly above or after the variable where it occurs in the source.
  • Updated 01/31/2022: Doxyfile.in parameter EXTENSION_MAPPING edited for Fortran90 files using the .F90 suffix. Fixes doxygen error, state: 22(String), identified by @ukmo-ccbunney .

What bug does it fix, or what feature does it add?

  • ww3_doxy_tmpl.md: It corrects the way to document module variables.
  • Doxygen.in: Fixes error state: 22(String).

Is a change of answers expected from this PR?

  • No. This only affects the documentation files ww3_doxy_tmpl.md and Doxygen.in.

Please also include the following information:

  • Add any suggestions for a reviewer
    • N/A.
  • Mention any labels that should be added:
    • documentation.
  • Are answer changes expected from this PR? Please describe the changes and the reason why in addition to which of the following labels would apply.
    • No answers to change -- no edits to source code.

Issue(s) addressed

Not associated with an issue.

Commit Message

ww3_doxy_tmpl.md, Doxyfile.in fixes

Check list

Testing

  • How were these changes tested?
    • No testing. No source edits were made.
  • Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
    • N/A.
  • Have the matrix regression tests been run (if yes, please note HPC and compiler)?
    • N/A.
  • Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):
    • N/A, see above.
  • Please indicate the expected changes in the regression test output (Note the known list of non-identical tests).
    • N/A, see above.
  • Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):
    • N/A, see above.

@ukmo-ccbunney
Copy link
Copy Markdown
Collaborator

ukmo-ccbunney commented Feb 1, 2022

@MatthewMasarik-NOAA I can confirm that the f=FortranFixed f90=FortranFree F90=FortranFree addition to Doxyfile.in fixes the State errors I was getting for many files. It also fixes the weird issue with my w3ounfmetamd.F90 file requiring that comment line between the Doxygen markup and the MODULE definition line.

@MatthewMasarik-NOAA
Copy link
Copy Markdown
Contributor Author

MatthewMasarik-NOAA commented Feb 1, 2022

@MatthewMasarik-NOAA I can confirm that the f=FortranFixed f90=FortranFree F90=FortranFree addition to Doxyfile.in fixes the State errors I was getting for many files. It also fixes the weird issue with my w3ounfmetamd.F90 file requiring that comment line between the Doxygen markup and the MODULE definition line.

@ukmo-ccbunney Awesome! I'm glad to hear that : ) After making that change there were only a few errors I was getting too. @edwardhartnett mentioned removing all the errors, then requiring people's checkin's be error free going forward. This is probably the way to go, so I've worked on removing them and just have one left at this point. I'll have all the error's removed before submitting the batch of marked up files.

@aliabdolali aliabdolali self-requested a review February 1, 2022 18:43
aliabdolali
aliabdolali approved these changes Feb 1, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@aliabdolali aliabdolali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After a discussion with Matt, I am happy with this PR.

@aliabdolali aliabdolali merged commit c166e4c into NOAA-EMC:develop Feb 1, 2022
@MatthewMasarik-NOAA MatthewMasarik-NOAA deleted the doc/module-vars branch February 1, 2022 22:44
aliabdolali pushed a commit that referenced this pull request Mar 16, 2022
@MatthewMasarik-NOAA @aliabdolali
ww3_doxy_tmpl.md: fix module vars (#599)
89651a5 
ww3_doxy_tmpl.md, Doxyfile.in fixes
kestonsmith-noaa pushed a commit to kestonsmith-noaa/WW3 that referenced this pull request Jun 17, 2025
@binli2337
Update CDEPS submodule and CDEPS tests (NOAA-EMC#599)
d0f0324 
* Point CDEPS to develop branch of NOAA-EMC/CDEPS
* Change application name "DATM" to "NG-GODAS"
* Change application name "DATM-NEMS" to "NG-GODAS-NEMSDATM"
* Use a mesh file in MOM6 cap instead of a grid file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@aliabdolali aliabdolali aliabdolali approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MatthewMasarik-NOAA @ukmo-ccbunney @aliabdolali